<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilasu: KeyWrap Common APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilasu
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xasu__keywrap__common__apis.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">KeyWrap Common APIs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaebbe4c517b8f6239dec975d46d6140e1"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xasu__keywrap__common__apis.html#gaebbe4c517b8f6239dec975d46d6140e1">XAsu_KeyWrapUnwrapValidateInputParams</a> (const <a class="el" href="struct_x_asu___key_wrap_params.html">XAsu_KeyWrapParams</a> *KwpunwpParamsPtr)</td></tr>
<tr class="memdesc:gaebbe4c517b8f6239dec975d46d6140e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function validates input parameters for key wrap and unwrap.  <a href="#gaebbe4c517b8f6239dec975d46d6140e1">More...</a><br/></td></tr>
<tr class="separator:gaebbe4c517b8f6239dec975d46d6140e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaebbe4c517b8f6239dec975d46d6140e1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XAsu_KeyWrapUnwrapValidateInputParams </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_asu___key_wrap_params.html">XAsu_KeyWrapParams</a> *&#160;</td>
          <td class="paramname"><em>KwpunwpParamsPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function validates input parameters for key wrap and unwrap. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">KwpunwpParamsPtr</td><td>Pointer to <a class="el" href="struct_x_asu___key_wrap_params.html" title="This structure contains Key wrap unwrap params info. ">XAsu_KeyWrapParams</a> structure that holds the input parameters for Key wrap and unwrap</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS, if input validation is successful.<ul>
<li>XST_FAILURE, if input validation fails. </li>
</ul>
</li>
</ul>
</dd></dl>
<p>Validate that the addresses of all input and output buffers are non-zero.</p>
<p>Validate that the length of all input and output sizes are non-zero.</p>
<p>Validate AES key size.</p>
<p>Validate SHA type and Mode.</p>
<p>Validate RSA key size. </p>

<p>References <a class="el" href="struct_x_asu___key_wrap_params.html#ade44d0624d16df27a61c0ccb67d5c74b">XAsu_KeyWrapParams::ActualOutuputDataLenAddr</a>, <a class="el" href="struct_x_asu___key_wrap_params.html#aadaa548059c19c40a13624d158c4efd4">XAsu_KeyWrapParams::AesKeySize</a>, <a class="el" href="struct_x_asu___key_wrap_params.html#a7e975623b5d478db1451042b05b662ea">XAsu_KeyWrapParams::InputDataAddr</a>, <a class="el" href="struct_x_asu___key_wrap_params.html#a776bcc1fcddaf0b9d9b4323f4051ee85">XAsu_KeyWrapParams::InputDataLen</a>, <a class="el" href="struct_x_asu___key_wrap_params.html#ac1f5e0fc07b7e1b19fcccfe352442269">XAsu_KeyWrapParams::KeyCompAddr</a>, <a class="el" href="struct_x_asu___key_wrap_params.html#a35bf5a34cf3e2325bdcf3100f82af618">XAsu_KeyWrapParams::OptionalLabelAddr</a>, <a class="el" href="struct_x_asu___key_wrap_params.html#abf6549ec448bea10512c895abf9baf07">XAsu_KeyWrapParams::OptionalLabelSize</a>, <a class="el" href="struct_x_asu___key_wrap_params.html#aa7cbcf8280698e9df3458951df9959ec">XAsu_KeyWrapParams::OutputDataAddr</a>, <a class="el" href="struct_x_asu___key_wrap_params.html#a483d09085d77a62e55365da37cb9c3c5">XAsu_KeyWrapParams::OutuputDataLen</a>, <a class="el" href="struct_x_asu___key_wrap_params.html#a38fcf90cf3ca3349320ec043a58e065b">XAsu_KeyWrapParams::RsaKeySize</a>, <a class="el" href="struct_x_asu___key_wrap_params.html#a3d2c47719c3dab4ce5dd8222487751b8">XAsu_KeyWrapParams::ShaMode</a>, <a class="el" href="struct_x_asu___key_wrap_params.html#abb2a09abd19af9c8165f7dadf6b365ab">XAsu_KeyWrapParams::ShaType</a>, <a class="el" href="group__xasu__common__defs.html#ga7d2c1e79c450b652a8a299a7de7543f1">XASU_AES_KEY_SIZE_128_BITS</a>, <a class="el" href="group__xasu__common__defs.html#ga565a9f9f9f947674eb43a1ce60e638d6">XASU_AES_KEY_SIZE_256_BITS</a>, <a class="el" href="group__xasu__common__defs.html#ga7af115dffedb0e4d090e6fa4561a0693">XASU_SHA3_TYPE</a>, <a class="el" href="group__xasu__common__defs.html#ga2ff7f0c006a8fd37526d549b4b02b511">XASU_SHA_MODE_SHA256</a>, <a class="el" href="group__xasu__common__defs.html#ga8abe96be07950583b1b86b109031db97">XASU_SHA_MODE_SHA384</a>, <a class="el" href="group__xasu__common__defs.html#gaf72009eaaf78e4306eba5db7264a6560">XASU_SHA_MODE_SHA512</a>, and <a class="el" href="group__xasu__common__defs.html#gaacee72cf9c2d25a922f117c6da956f25">XASU_SHA_MODE_SHAKE256</a>.</p>

<p>Referenced by <a class="el" href="group__xasu__keywrap__client__apis.html#ga5182a3df4600b1e0c78db02eab118fe7">XAsu_KeyUnwrap()</a>, and <a class="el" href="group__xasu__keywrap__client__apis.html#gad64883d138efba842bfc4961b3c8ee0f">XAsu_KeyWrap()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
